chore: Design documentation structure#216
Merged
Merged
Conversation
📝 WalkthroughWalkthroughSix new documentation index pages are added to the Designer section under Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (10)
content/docs/designer/02-nodes/_index.md (2)
2-5:⚠️ Potential issue | 🔴 CriticalFix duplicate title and weight values.
This file should have
title: "Nodes"andweight: 2to match its02-nodesdirectory.🛠️ Suggested fix
--- -title: "Designer" -description: "update here" +title: "Nodes" +description: "Working with nodes in the Designer" date: 2026-03-25 -weight: 3 +weight: 2 draft: true ---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/02-nodes/_index.md` around lines 2 - 5, Update the front-matter in the file to fix duplicated metadata: change the title key value from "Designer" to "Nodes" and change the weight value from 3 to 2 so they match the containing directory `02-nodes`; ensure only the title and weight fields are modified (keep description and date as-is).
17-17:⚠️ Potential issue | 🟡 MinorCapitalize "YouTube" in user-facing text.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/02-nodes/_index.md` at line 17, The user-facing occurrence of "youtube" in the document (the string "youtube" in the sentence "Example of useful shortcodes for image-code toggle, images and youtube videos:") should be capitalized as "YouTube"; update that string in the file (the markdown line containing "images and youtube videos") so all user-facing text uses the correct brand capitalization.content/docs/designer/03-reordering-nodes/_index.md (2)
2-5:⚠️ Potential issue | 🔴 CriticalFix duplicate title and weight values.
This file has the same issues as all other Designer section files:
title: "Designer"should betitle: "Reordering Nodes"andweight: 3should be unique (likelyweight: 3is correct for this file given the03-directory prefix).🛠️ Suggested fix
--- -title: "Designer" -description: "update here" +title: "Reordering Nodes" +description: "Learn how to reorder nodes in the Designer canvas" date: 2026-03-25 weight: 3 draft: true ---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/03-reordering-nodes/_index.md` around lines 2 - 5, Update the frontmatter: change the title field from "Designer" to "Reordering Nodes" (replace the value of title) and ensure the weight field is the correct unique integer for this page (confirm or set weight: 3 to match the 03- prefix and avoid duplicates); edit the title and weight values in the file's frontmatter so they match the page purpose and do not collide with other Designer section files.
17-17:⚠️ Potential issue | 🟡 MinorCapitalize "YouTube" in user-facing text.
Same capitalization issue as in other files.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/03-reordering-nodes/_index.md` at line 17, The user-facing text contains a lowercase "youtube" in the line "Example of useful shortcodes for image-code toggle, images and youtube videos"—capitalize "YouTube" to fix the branding; update the string wherever the same lowercase occurs in this document (and other docs if duplicated) so occurrences like "youtube" become "YouTube" (search for the literal "youtube" and replace with "YouTube", e.g., in the line shown and any similar headings or sentences).content/docs/designer/04-runtime-selector/_index.md (2)
17-17:⚠️ Potential issue | 🟡 MinorCapitalize "YouTube" in user-facing text.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/04-runtime-selector/_index.md` at line 17, The user-facing instance of "youtube" in the runtime-selector docs should be capitalized to "YouTube"; update the text in the sentence containing "image-code toggle, images and youtube videos" (in _index.md) to use "YouTube" so the brand name is correctly capitalized.
2-5:⚠️ Potential issue | 🔴 CriticalFix duplicate title and weight values.
This file should have
title: "Runtime Selector"andweight: 4to match its04-runtime-selectordirectory.🛠️ Suggested fix
--- -title: "Designer" -description: "update here" +title: "Runtime Selector" +description: "Select and configure runtime environments" date: 2026-03-25 -weight: 3 +weight: 4 draft: true ---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/04-runtime-selector/_index.md` around lines 2 - 5, Update the frontmatter in the _index.md file so the title and weight match the directory: change the title field from "Designer" to "Runtime Selector" and change weight from 3 to 4; locate and edit the top YAML/frontmatter block that contains the title and weight keys to make these updates (fields: title, weight).content/docs/designer/05-executing-routes/_index.md (2)
2-5:⚠️ Potential issue | 🔴 CriticalFix duplicate title and weight values.
This file should have
title: "Executing Routes"andweight: 5to match its05-executing-routesdirectory.🛠️ Suggested fix
--- -title: "Designer" -description: "update here" +title: "Executing Routes" +description: "Run and test your routes in the Designer" date: 2026-03-25 -weight: 3 +weight: 5 draft: true ---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/05-executing-routes/_index.md` around lines 2 - 5, Update the frontmatter keys in this markdown: change the title key from "Designer" to "Executing Routes" and change the weight key from 3 to 5 so the file matches its 05-executing-routes directory; locate the top-level YAML-like keys `title:` and `weight:` in _index.md and replace their values accordingly.
17-17:⚠️ Potential issue | 🟡 MinorCapitalize "YouTube" in user-facing text.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/05-executing-routes/_index.md` at line 17, The user-facing occurrence of "youtube" should be capitalized as "YouTube"; locate the text line containing the lowercase token "youtube" in content/docs/designer/05-executing-routes/_index.md (the example list item "images and youtube videos") and update that token to "YouTube" so the product-facing documentation uses the correct brand capitalization.content/docs/designer/01-managing-routes/_index.md (2)
17-17:⚠️ Potential issue | 🟡 MinorCapitalize "YouTube" in user-facing text.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/01-managing-routes/_index.md` at line 17, The user-facing text contains a lowercase "youtube" in the sentence 'Example of useful shortcodes for image-code toggle, images and youtube videos:'—update that string to capitalize "YouTube" so it reads '...images and YouTube videos:'; ensure any other occurrences of the brand name in this document (e.g., within the same paragraph or nearby headings) are also capitalized consistently.
2-5:⚠️ Potential issue | 🔴 CriticalFix duplicate title and weight values.
This file should have
title: "Managing Routes"andweight: 1to match its01-managing-routesdirectory.🛠️ Suggested fix
--- -title: "Designer" -description: "update here" +title: "Managing Routes" +description: "Create, edit, and manage routes in the Designer" date: 2026-03-25 -weight: 3 +weight: 1 draft: true ---🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/01-managing-routes/_index.md` around lines 2 - 5, Update the front-matter in this document by changing the title and weight values: replace title: "Designer" with title: "Managing Routes" and change weight: 3 to weight: 1 so the front-matter (title and weight keys) matches the surrounding 01-managing-routes directory; ensure the rest of the YAML lines (description and date) remain unchanged.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/docs/designer/06-settings/_index.md`:
- Line 17: The user-facing text in the list item "4. Example of useful
shortcodes for image-code toggle, images and youtube videos:" uses a lowercase
"youtube"; update that string to "4. Example of useful shortcodes for image-code
toggle, images and YouTube videos:" so the platform name is capitalized
correctly (locate and edit the markdown line containing "image-code toggle,
images and youtube videos"). Ensure only the capitalization of "YouTube" is
changed and preserve the rest of the sentence.
- Around line 2-5: The frontmatter in this file uses the wrong section title and
weight; update the YAML frontmatter keys `title` and `weight` in this
`_index.md` so `title` is "Settings" (to match the directory/section) and
`weight` is 6 (to match the `06-` prefix and correct Hugo menu order). Locate
the top-of-file frontmatter block where `title: "Designer"` and `weight: 3` are
set and replace those values accordingly.
---
Duplicate comments:
In `@content/docs/designer/01-managing-routes/_index.md`:
- Line 17: The user-facing text contains a lowercase "youtube" in the sentence
'Example of useful shortcodes for image-code toggle, images and youtube
videos:'—update that string to capitalize "YouTube" so it reads '...images and
YouTube videos:'; ensure any other occurrences of the brand name in this
document (e.g., within the same paragraph or nearby headings) are also
capitalized consistently.
- Around line 2-5: Update the front-matter in this document by changing the
title and weight values: replace title: "Designer" with title: "Managing Routes"
and change weight: 3 to weight: 1 so the front-matter (title and weight keys)
matches the surrounding 01-managing-routes directory; ensure the rest of the
YAML lines (description and date) remain unchanged.
In `@content/docs/designer/02-nodes/_index.md`:
- Around line 2-5: Update the front-matter in the file to fix duplicated
metadata: change the title key value from "Designer" to "Nodes" and change the
weight value from 3 to 2 so they match the containing directory `02-nodes`;
ensure only the title and weight fields are modified (keep description and date
as-is).
- Line 17: The user-facing occurrence of "youtube" in the document (the string
"youtube" in the sentence "Example of useful shortcodes for image-code toggle,
images and youtube videos:") should be capitalized as "YouTube"; update that
string in the file (the markdown line containing "images and youtube videos") so
all user-facing text uses the correct brand capitalization.
In `@content/docs/designer/03-reordering-nodes/_index.md`:
- Around line 2-5: Update the frontmatter: change the title field from
"Designer" to "Reordering Nodes" (replace the value of title) and ensure the
weight field is the correct unique integer for this page (confirm or set weight:
3 to match the 03- prefix and avoid duplicates); edit the title and weight
values in the file's frontmatter so they match the page purpose and do not
collide with other Designer section files.
- Line 17: The user-facing text contains a lowercase "youtube" in the line
"Example of useful shortcodes for image-code toggle, images and youtube
videos"—capitalize "YouTube" to fix the branding; update the string wherever the
same lowercase occurs in this document (and other docs if duplicated) so
occurrences like "youtube" become "YouTube" (search for the literal "youtube"
and replace with "YouTube", e.g., in the line shown and any similar headings or
sentences).
In `@content/docs/designer/04-runtime-selector/_index.md`:
- Line 17: The user-facing instance of "youtube" in the runtime-selector docs
should be capitalized to "YouTube"; update the text in the sentence containing
"image-code toggle, images and youtube videos" (in _index.md) to use "YouTube"
so the brand name is correctly capitalized.
- Around line 2-5: Update the frontmatter in the _index.md file so the title and
weight match the directory: change the title field from "Designer" to "Runtime
Selector" and change weight from 3 to 4; locate and edit the top
YAML/frontmatter block that contains the title and weight keys to make these
updates (fields: title, weight).
In `@content/docs/designer/05-executing-routes/_index.md`:
- Around line 2-5: Update the frontmatter keys in this markdown: change the
title key from "Designer" to "Executing Routes" and change the weight key from 3
to 5 so the file matches its 05-executing-routes directory; locate the top-level
YAML-like keys `title:` and `weight:` in _index.md and replace their values
accordingly.
- Line 17: The user-facing occurrence of "youtube" should be capitalized as
"YouTube"; locate the text line containing the lowercase token "youtube" in
content/docs/designer/05-executing-routes/_index.md (the example list item
"images and youtube videos") and update that token to "YouTube" so the
product-facing documentation uses the correct brand capitalization.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 6f82d390-d50b-4a0e-bb9f-027a545ce3b6
📒 Files selected for processing (6)
content/docs/designer/01-managing-routes/_index.mdcontent/docs/designer/02-nodes/_index.mdcontent/docs/designer/03-reordering-nodes/_index.mdcontent/docs/designer/04-runtime-selector/_index.mdcontent/docs/designer/05-executing-routes/_index.mdcontent/docs/designer/06-settings/_index.md
PVinaches
reviewed
Mar 30, 2026
PVinaches
left a comment
PVinaches
left a comment
Member
There was a problem hiding this comment.
We need to set the title (even if it is a provisional one) and weight to have the side menu updated before merging. Else every subsection will appear as 'Designer' and compete to bein position 3. I am not sure though if the weight needs to be 3.1, 3.2,... Or it can be restarting as 1, 2,...
lordrip
force-pushed
the
chore/design-structure
branch
from
6a9ff35 to
2c3ec03
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
content/docs/designer/01-managing-routes/_index.md (1)
9-41: Consider centralizing this repeated authoring template.This block is duplicated across all new Designer pages. Consider moving it to a shared Hugo archetype/partial to reduce copy/paste drift and future update cost.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@content/docs/designer/01-managing-routes/_index.md` around lines 9 - 41, The duplicated "Some instructions:" authoring block (including the example shortcodes like {{< img-toggle ... >}}, {{< figure ... >}} and {{< youtube ... >}}) appears in every new Designer page; extract this repeated content into a single shared Hugo archetype or partial (e.g., a Designer archetype/partial) and replace the inline block in each index.md with a short include or use the archetype when creating new pages so updates are made in one place and all pages inherit the change.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@content/docs/designer/02-nodes/_index.md`:
- Line 17: The user-facing string "Example of useful shortcodes for image-code
toggle, images and youtube videos:" should capitalize the platform name; update
the sentence (the text containing "image-code toggle, images and youtube
videos") to use "YouTube" (capital T) instead of "youtube" so the line reads
"...images and YouTube videos:"; keep the rest of the wording unchanged.
---
Nitpick comments:
In `@content/docs/designer/01-managing-routes/_index.md`:
- Around line 9-41: The duplicated "Some instructions:" authoring block
(including the example shortcodes like {{< img-toggle ... >}}, {{< figure ...
>}} and {{< youtube ... >}}) appears in every new Designer page; extract this
repeated content into a single shared Hugo archetype or partial (e.g., a
Designer archetype/partial) and replace the inline block in each index.md with a
short include or use the archetype when creating new pages so updates are made
in one place and all pages inherit the change.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e90f5144-f775-4758-b876-5aa68736c5fb
📒 Files selected for processing (6)
content/docs/designer/01-managing-routes/_index.mdcontent/docs/designer/02-nodes/_index.mdcontent/docs/designer/03-reordering-nodes/_index.mdcontent/docs/designer/04-runtime-selector/_index.mdcontent/docs/designer/05-executing-routes/_index.mdcontent/docs/designer/06-settings/_index.md
PVinaches
approved these changes
Mar 31, 2026
This was referenced Mar 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit